fix(build): webviews sometimes did not load during development #6556
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Problem: In our development build we spawn a webpack server that serves the Vue files used by our webviews. It is served on port 8080, but sometimes an existing process is already using it, and this causes the webpack server to use the next available port. But because we assume it will use 8080 it silently breaks. Solution: Explicitly require 8080 in the webpack server cli command, also create a custom script to catch the error early and explain how to resolve it. Signed-off-by: nkomonen-amazon <[email protected]>
|
nkomonen-amazon
commented
Feb 11, 2025
| "cwd": "${workspaceFolder}/../../packages/core" | ||
| } | ||
| }, | ||
| "presentation": { "panel": "dedicated" } |
Contributor
Author
There was a problem hiding this comment.
This solved the following issue:
- The webpack serve command would fail
- A subsequent build task would reuse this terminal since it failed
- The reuse caused the port in use error message to be hidden
Now the webpack serve command is in a dedicated terminal that does not disappear, so it is more obvious when it breaks.
jpinkney-aws
approved these changes
Feb 11, 2025
| "compileDev": "npm run compile -- --mode development", | ||
| "webpackDev": "webpack --mode development", | ||
| "serveVue": "webpack serve --config-name vue --mode development", | ||
| "serveVue": "ts-node ./scripts/build/checkServerPort.ts && webpack serve --port 8080 --config-name vue --mode development", |
Contributor
There was a problem hiding this comment.
is the explicitness just to make it easy to identify that the webpack port and the port in checkServerPort are easy?
Contributor
Author
There was a problem hiding this comment.
the explicit --port 8080 is a fallback in case something breaks in the script, but isn't explicitly needed. Also by default webpack serve will use 8080, so I thought it would just help make that more obvious.
Hweinstock
approved these changes
Feb 11, 2025
justinmk3
approved these changes
Feb 11, 2025
s7ab059789
pushed a commit
to s7ab059789/aws-toolkit-vscode
that referenced
this pull request
Feb 19, 2025
) ## Problem: In our development build we spawn a webpack server that serves the Vue files used by our webviews. It is served on port 8080, but sometimes an existing process is already using it, and this causes the webpack server to use the next available port. But because we assume it will use 8080 it silently breaks, and when developing the Q webview would not load as expected. ## Solution: Explicitly require 8080 in the webpack server cli command, also create a custom script to catch the error early and explain how to resolve it. Now in the build tasks if 8080 is in use the dev can see the failed task with the solution explicitly stated. --- - Treat all work as PUBLIC. Private `feature/x` branches will not be squash-merged at release time. - Your code changes must meet the guidelines in [CONTRIBUTING.md](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#guidelines). - License: I confirm that my contribution is made under the terms of the Apache 2.0 license. Signed-off-by: nkomonen-amazon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem:
In our development build we spawn a webpack server that serves the Vue files used by our webviews. It is served on port 8080, but sometimes an existing process is already using it, and this causes the webpack server to use the next available port. But because we assume it will use 8080 it silently breaks, and when developing the Q webview would not load as expected.
Solution:
Explicitly require 8080 in the webpack server cli command, also create a custom script to catch the error early and explain how to resolve it.
Now in the build tasks if 8080 is in use the dev can see the failed task with the solution explicitly stated.
feature/xbranches will not be squash-merged at release time.